/*
 * OptionPluginSelector.java
 * 
 * Copyright (c) 2009, Ralf Biedert All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer. Redistributions in binary form must reproduce the
 * above copyright notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the author nor the names of its contributors may be used to endorse or
 * promote products derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 */
package net.xeoh.plugins.base.options.getplugin;

import net.xeoh.plugins.base.Plugin;
import net.xeoh.plugins.base.PluginManager;
import net.xeoh.plugins.base.options.GetPluginOption;
import net.xeoh.plugins.base.util.PluginManagerUtil;

/**
 * Passes a plugin selector as an option. The selector will be called for each considered plugin. 
 * The first plugin on which the collector returns <code>true</code> will be returned. For example, 
 * to select a remote service based on its protocol, write:<br/><br/>
 * 
 * <code>
 * getPlugin(RemoteAPI.class, new OptionPluginSelector<RemoteAPI>(new PluginSelector<RemoteAPI>() {<br/>
 * &nbsp;&nbsp;&nbsp;&nbsp;public boolean selectPlugin(final RemoteAPI p) {<br/>
 * &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (p.getPublishMethod() == PublishMethod.JSON) return true;<br/>
 * &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return false;<br/>
 * }<br/>
 *  }));<br/>
 * </code><br/><br/>
 * 
 * The plugin selector is especially useful to iterate over all plugins, {@link PluginManagerUtil} 
 * already does that for you.
 * 
 * @author Ralf Biedert
 * @see PluginManager
 * @param <P> Type of the plugin.
 */
public final class OptionPluginSelector<P extends Plugin> implements GetPluginOption {

    /** */
    private static final long serialVersionUID = 6540623006341980932L;

    /** */
    private PluginSelector<P> value;

    /**
     * Creates a new selectop option with the given selelector.
     * 
     * @param ps The plugin selector to add.
     */
    public OptionPluginSelector(PluginSelector<P> ps) {
        this.value = ps;
    }

    /**
     * Returns the passed selector.
     * 
     * @return The selector enclosed.
     */
    public PluginSelector<P> getSelector() {
        return this.value;
    }
}
